core/androidx.core.content/[main]PermissionChecker

PermissionChecker

This class provides permission check APIs that verify both the permission and the associated app op for this permission if such is defined.

In the new permission model permissions with protection level dangerous are runtime permissions. For apps targeting M and above the user may not grant such permissions or revoke them at any time. For apps targeting API lower than M these permissions are always granted as such apps do not expect permission revocations and would crash. Therefore, when the user disables a permission for a legacy app in the UI the platform disables the APIs guarded by this permission making them a no-op which is doing nothing or returning an empty result or default error.

It is important that when you perform an operation on behalf of another app you use these APIs to check for permissions as the app may be a legacy app that does not participate in the new permission model for which the user had disabled the "permission" which is achieved by disallowing the corresponding app op.

Types

PermissionResult

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Retention(value = RetentionPolicy.SOURCE)

annotation class PermissionResult

Properties

PERMISSION_DENIED

val PERMISSION_DENIED: Int = -1

Permission result: The permission is denied.

PERMISSION_DENIED_APP_OP

val PERMISSION_DENIED_APP_OP: Int = -2

Permission result: The permission is denied because the app op is not allowed.

PERMISSION_GRANTED

val PERMISSION_GRANTED: Int = 0

Permission result: The permission is granted.

Functions

checkCallingOrSelfPermission

open fun checkCallingOrSelfPermission(@NonNull context: Context, @NonNull permission: String): Int

Checks whether the IPC you are handling or your app has a given permission and whether the app op that corresponds to this permission is allowed.

checkCallingPermission

open fun checkCallingPermission(@NonNull context: Context, @NonNull permission: String, @Nullable packageName: String): Int

Checks whether the IPC you are handling has a given permission and whether the app op that corresponds to this permission is allowed.

checkPermission

open fun checkPermission(@NonNull context: Context, @NonNull permission: String, pid: Int, uid: Int, @Nullable packageName: String): Int

Checks whether a given package in a UID and PID has a given permission and whether the app op that corresponds to this permission is allowed.

checkSelfPermission

open fun checkSelfPermission(@NonNull context: Context, @NonNull permission: String): Int

Checks whether your app has a given permission and whether the app op that corresponds to this permission is allowed.